<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>DatabaseMap xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/apache/torque/map/DatabaseMap.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <strong>package</strong> <a href="../../../../org/apache/torque/map/package-summary.html">org.apache.torque.map</a>;
<a name="2" href="#2">2</a>   
<a name="3" href="#3">3</a>   <em class="comment">/*</em>
<a name="4" href="#4">4</a>   <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="5" href="#5">5</a>   <em class="comment"> * or more contributor license agreements.  See the NOTICE file</em>
<a name="6" href="#6">6</a>   <em class="comment"> * distributed with this work for additional information</em>
<a name="7" href="#7">7</a>   <em class="comment"> * regarding copyright ownership.  The ASF licenses this file</em>
<a name="8" href="#8">8</a>   <em class="comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="9" href="#9">9</a>   <em class="comment"> * "License"); you may not use this file except in compliance</em>
<a name="10" href="#10">10</a>  <em class="comment"> * with the License.  You may obtain a copy of the License at</em>
<a name="11" href="#11">11</a>  <em class="comment"> *</em>
<a name="12" href="#12">12</a>  <em class="comment"> *   <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="13" href="#13">13</a>  <em class="comment"> *</em>
<a name="14" href="#14">14</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="15" href="#15">15</a>  <em class="comment"> * software distributed under the License is distributed on an</em>
<a name="16" href="#16">16</a>  <em class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="17" href="#17">17</a>  <em class="comment"> * KIND, either express or implied.  See the License for the</em>
<a name="18" href="#18">18</a>  <em class="comment"> * specific language governing permissions and limitations</em>
<a name="19" href="#19">19</a>  <em class="comment"> * under the License.</em>
<a name="20" href="#20">20</a>  <em class="comment"> */</em>
<a name="21" href="#21">21</a>  
<a name="22" href="#22">22</a>  <strong>import</strong> java.lang.reflect.Method;
<a name="23" href="#23">23</a>  <strong>import</strong> java.text.MessageFormat;
<a name="24" href="#24">24</a>  <strong>import</strong> java.util.Collections;
<a name="25" href="#25">25</a>  <strong>import</strong> java.util.HashMap;
<a name="26" href="#26">26</a>  <strong>import</strong> java.util.Iterator;
<a name="27" href="#27">27</a>  <strong>import</strong> java.util.Map;
<a name="28" href="#28">28</a>  <strong>import</strong> java.util.StringTokenizer;
<a name="29" href="#29">29</a>  
<a name="30" href="#30">30</a>  <strong>import</strong> org.apache.commons.collections.map.ListOrderedMap;
<a name="31" href="#31">31</a>  <strong>import</strong> org.apache.commons.lang.StringUtils;
<a name="32" href="#32">32</a>  <strong>import</strong> org.apache.torque.TorqueException;
<a name="33" href="#33">33</a>  <strong>import</strong> org.apache.torque.adapter.IDMethod;
<a name="34" href="#34">34</a>  <strong>import</strong> org.apache.torque.oid.IDBroker;
<a name="35" href="#35">35</a>  <strong>import</strong> org.apache.torque.oid.IdGenerator;
<a name="36" href="#36">36</a>  
<a name="37" href="#37">37</a>  <em>/**<em>*</em></em>
<a name="38" href="#38">38</a>  <em> * DatabaseMap is used to model a database.</em>
<a name="39" href="#39">39</a>  <em> *</em>
<a name="40" href="#40">40</a>  <em> * @author &lt;a href="<a href="mailto:jmcnally@collab.net" target="alexandria_uri">mailto:jmcnally@collab.net</a>">John D. McNally&lt;/a></em>
<a name="41" href="#41">41</a>  <em> * @author &lt;a href="<a href="mailto:dlr@collab.net" target="alexandria_uri">mailto:dlr@collab.net</a>">Daniel Rall&lt;/a></em>
<a name="42" href="#42">42</a>  <em> * @author &lt;a href="<a href="mailto:greg.monroe@dukece.com" target="alexandria_uri">mailto:greg.monroe@dukece.com</a>">Greg Monroe&lt;/a></em>
<a name="43" href="#43">43</a>  <em> * @version $Id: DatabaseMap.java 476550 2006-11-18 16:08:37Z tfischer $</em>
<a name="44" href="#44">44</a>  <em> */</em>
<a name="45" href="#45">45</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../org/apache/torque/map/DatabaseMap.html">DatabaseMap</a> implements java.io.Serializable
<a name="46" href="#46">46</a>  {
<a name="47" href="#47">47</a>      <em>/**<em>*</em></em>
<a name="48" href="#48">48</a>  <em>     * The character used by most implementations as the separator</em>
<a name="49" href="#49">49</a>  <em>     * between name elements.</em>
<a name="50" href="#50">50</a>  <em>     */</em>
<a name="51" href="#51">51</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> <strong>char</strong> STD_SEPARATOR_CHAR = '_';
<a name="52" href="#52">52</a>  
<a name="53" href="#53">53</a>      <em>/**<em>*</em></em>
<a name="54" href="#54">54</a>  <em>     * The character which separates the schema name from the table name.</em>
<a name="55" href="#55">55</a>  <em>     */</em>
<a name="56" href="#56">56</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> <strong>char</strong> SCHEMA_SEPARATOR_CHAR = '.';
<a name="57" href="#57">57</a>  
<a name="58" href="#58">58</a>      <em>/**<em>*</em></em>
<a name="59" href="#59">59</a>  <em>     * Format used to create create the class name for initializing a DB</em>
<a name="60" href="#60">60</a>  <em>     * specific map</em>
<a name="61" href="#61">61</a>  <em>     */</em>
<a name="62" href="#62">62</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> String INIT_CLASS_NAME_FORMAT =
<a name="63" href="#63">63</a>                                  <span class="string">"org.apache.torque.linkage.{0}MapInit"</span>;
<a name="64" href="#64">64</a>  
<a name="65" href="#65">65</a>      <em>/**<em>*</em></em>
<a name="66" href="#66">66</a>  <em>     * Error Messages for initialisation.</em>
<a name="67" href="#67">67</a>  <em>     */</em>
<a name="68" href="#68">68</a>      <strong>protected</strong> <strong>static</strong> <strong>final</strong> String[] ERROR_MESSAGES_INIT = {
<a name="69" href="#69">69</a>          <span class="string">"Invalid Torque OM setup for Database \&quot;{0}\&quot;.\n"</span>
<a name="70" href="#70">70</a>          + <span class="string">"Database Map initialization class, \&quot;{1}\&quot;,"</span> + <span class="string">" "</span>
<a name="71" href="#71">71</a>          + <span class="string">"could not be found in your classpath."</span>,
<a name="72" href="#72">72</a>          <span class="string">"Invalid Torque OM setup for Database \&quot;{0}\&quot;.\n"</span>
<a name="73" href="#73">73</a>          + <span class="string">"A class that the Database Map initialization class, \&quot;{1}\&quot;, "</span>
<a name="74" href="#74">74</a>          + <span class="string">"depends on could not be found."</span>,
<a name="75" href="#75">75</a>          <span class="string">"Invalid Torque OM setup for Database \&quot;{0}\&quot;.\n"</span>
<a name="76" href="#76">76</a>          + <span class="string">"Something unexpected happened doing Class.forName(\&quot;{1}\&quot;).  "</span>
<a name="77" href="#77">77</a>          + <span class="string">"See the nested exception for details."</span>,
<a name="78" href="#78">78</a>          <span class="string">"Invalid Torque OM setup for Database \&quot;{0}\&quot;.\n"</span>
<a name="79" href="#79">79</a>          + <span class="string">"An error occured invoking the init() method in class, \&quot;{1}\&quot;"</span>
<a name="80" href="#80">80</a>      };
<a name="81" href="#81">81</a>  
<a name="82" href="#82">82</a>      <em>/**<em>* The serialVersionUID for this class. */</em></em>
<a name="83" href="#83">83</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> <strong>long</strong> serialVersionUID = 955251837095032274L;
<a name="84" href="#84">84</a>  
<a name="85" href="#85">85</a>      <em>/**<em>* The initial size of the Id-Generators map. */</em></em>
<a name="86" href="#86">86</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> <strong>int</strong> ID_GENERATORS_INITIAL_SIZE = 6;
<a name="87" href="#87">87</a>  
<a name="88" href="#88">88</a>      <em>/**<em>* Name of the database. */</em></em>
<a name="89" href="#89">89</a>      <strong>private</strong> String name;
<a name="90" href="#90">90</a>  
<a name="91" href="#91">91</a>      <em>/**<em>* Name of the tables in the database. */</em></em>
<a name="92" href="#92">92</a>      <strong>private</strong> Map tables;
<a name="93" href="#93">93</a>  
<a name="94" href="#94">94</a>      <em>/**<em>*</em></em>
<a name="95" href="#95">95</a>  <em>     * A special table used to generate primary keys for the other</em>
<a name="96" href="#96">96</a>  <em>     * tables.</em>
<a name="97" href="#97">97</a>  <em>     */</em>
<a name="98" href="#98">98</a>      <strong>private</strong> <a href="../../../../org/apache/torque/map/TableMap.html">TableMap</a> idTable = <strong>null</strong>;
<a name="99" href="#99">99</a>  
<a name="100" href="#100">100</a>     <em>/**<em>* The <a href="../../../../org/apache/torque/oid/IDBroker.html">IDBroker</a> that goes with the idTable. */</em></em>
<a name="101" href="#101">101</a>     <strong>private</strong> <a href="../../../../org/apache/torque/oid/IDBroker.html">IDBroker</a> idBroker = <strong>null</strong>;
<a name="102" href="#102">102</a> 
<a name="103" href="#103">103</a>     <em>/**<em>* The IdGenerators, keyed by type of idMethod. */</em></em>
<a name="104" href="#104">104</a>     <strong>private</strong> HashMap idGenerators;
<a name="105" href="#105">105</a> 
<a name="106" href="#106">106</a>     <em>/**<em>* Flag indicating that all tables have been loaded via initialize() */</em></em>
<a name="107" href="#107">107</a>     <strong>private</strong> <strong>boolean</strong> isInitialized = false;
<a name="108" href="#108">108</a> 
<a name="109" href="#109">109</a>     <em>/**<em>*</em></em>
<a name="110" href="#110">110</a> <em>     * Constructs a new DatabaseMap.</em>
<a name="111" href="#111">111</a> <em>     */</em>
<a name="112" href="#112">112</a>     <strong>public</strong> <a href="../../../../org/apache/torque/map/DatabaseMap.html">DatabaseMap</a>()
<a name="113" href="#113">113</a>     {
<a name="114" href="#114">114</a>         tables = Collections.synchronizedMap(<strong>new</strong> ListOrderedMap());
<a name="115" href="#115">115</a>         idGenerators = <strong>new</strong> HashMap(ID_GENERATORS_INITIAL_SIZE);
<a name="116" href="#116">116</a>     }
<a name="117" href="#117">117</a> 
<a name="118" href="#118">118</a>     <em>/**<em>*</em></em>
<a name="119" href="#119">119</a> <em>     * Constructor.</em>
<a name="120" href="#120">120</a> <em>     *</em>
<a name="121" href="#121">121</a> <em>     * @param name Name of the database.</em>
<a name="122" href="#122">122</a> <em>     * @param numberOfTables Number of tables in the database.</em>
<a name="123" href="#123">123</a> <em>     * @deprecated use DatabaseMap() instead. Will be removed</em>
<a name="124" href="#124">124</a> <em>     *             in a future version of Torque.</em>
<a name="125" href="#125">125</a> <em>     */</em>
<a name="126" href="#126">126</a>     <strong>public</strong> <a href="../../../../org/apache/torque/map/DatabaseMap.html">DatabaseMap</a>(String name, <strong>int</strong> numberOfTables)
<a name="127" href="#127">127</a>     {
<a name="128" href="#128">128</a>         <strong>this</strong>.name = name;
<a name="129" href="#129">129</a>         tables = Collections.synchronizedMap(<strong>new</strong> ListOrderedMap());
<a name="130" href="#130">130</a>         idGenerators = <strong>new</strong> HashMap(ID_GENERATORS_INITIAL_SIZE);
<a name="131" href="#131">131</a>     }
<a name="132" href="#132">132</a> 
<a name="133" href="#133">133</a>     <em>/**<em>*</em></em>
<a name="134" href="#134">134</a> <em>     * Constructor.</em>
<a name="135" href="#135">135</a> <em>     *</em>
<a name="136" href="#136">136</a> <em>     * @param name Name of the database.</em>
<a name="137" href="#137">137</a> <em>     * @deprecated use DatabaseMap() instead. Will be removed</em>
<a name="138" href="#138">138</a> <em>     *             in a future version of Torque.</em>
<a name="139" href="#139">139</a> <em>     */</em>
<a name="140" href="#140">140</a>     <strong>public</strong> <a href="../../../../org/apache/torque/map/DatabaseMap.html">DatabaseMap</a>(String name)
<a name="141" href="#141">141</a>     {
<a name="142" href="#142">142</a>         <strong>this</strong>.name = name;
<a name="143" href="#143">143</a>         tables = Collections.synchronizedMap(<strong>new</strong> ListOrderedMap());
<a name="144" href="#144">144</a>         idGenerators = <strong>new</strong> HashMap(ID_GENERATORS_INITIAL_SIZE);
<a name="145" href="#145">145</a>     }
<a name="146" href="#146">146</a> 
<a name="147" href="#147">147</a>     <em>/**<em>*</em></em>
<a name="148" href="#148">148</a> <em>     * Does this database contain this specific table?</em>
<a name="149" href="#149">149</a> <em>     *</em>
<a name="150" href="#150">150</a> <em>     * @param table The TableMap representation of the table.</em>
<a name="151" href="#151">151</a> <em>     * @return True if the database contains the table.</em>
<a name="152" href="#152">152</a> <em>     */</em>
<a name="153" href="#153">153</a>     <strong>public</strong> <strong>boolean</strong> containsTable(<a href="../../../../org/apache/torque/map/TableMap.html">TableMap</a> table)
<a name="154" href="#154">154</a>     {
<a name="155" href="#155">155</a>         <strong>return</strong> containsTable(table.getName());
<a name="156" href="#156">156</a>     }
<a name="157" href="#157">157</a> 
<a name="158" href="#158">158</a>     <em>/**<em>*</em></em>
<a name="159" href="#159">159</a> <em>     * Does this database contain this specific table?</em>
<a name="160" href="#160">160</a> <em>     *</em>
<a name="161" href="#161">161</a> <em>     * @param name The String representation of the table.</em>
<a name="162" href="#162">162</a> <em>     * @return True if the database contains the table.</em>
<a name="163" href="#163">163</a> <em>     */</em>
<a name="164" href="#164">164</a>     <strong>public</strong> <strong>boolean</strong> containsTable(String name)
<a name="165" href="#165">165</a>     {
<a name="166" href="#166">166</a>         <strong>if</strong> (name.indexOf('.') > 0)
<a name="167" href="#167">167</a>         {
<a name="168" href="#168">168</a>             name = name.substring(0, name.indexOf('.'));
<a name="169" href="#169">169</a>         }
<a name="170" href="#170">170</a>         <strong>return</strong> tables.containsKey(name);
<a name="171" href="#171">171</a>     }
<a name="172" href="#172">172</a> 
<a name="173" href="#173">173</a>     <em>/**<em>*</em></em>
<a name="174" href="#174">174</a> <em>     * Get the ID table for this database.</em>
<a name="175" href="#175">175</a> <em>     *</em>
<a name="176" href="#176">176</a> <em>     * @return A TableMap.</em>
<a name="177" href="#177">177</a> <em>     */</em>
<a name="178" href="#178">178</a>     <strong>public</strong> <a href="../../../../org/apache/torque/map/TableMap.html">TableMap</a> getIdTable()
<a name="179" href="#179">179</a>     {
<a name="180" href="#180">180</a>         <strong>return</strong> idTable;
<a name="181" href="#181">181</a>     }
<a name="182" href="#182">182</a> 
<a name="183" href="#183">183</a>     <em>/**<em>*</em></em>
<a name="184" href="#184">184</a> <em>     * Get the IDBroker for this database.</em>
<a name="185" href="#185">185</a> <em>     *</em>
<a name="186" href="#186">186</a> <em>     * @return An IDBroker.</em>
<a name="187" href="#187">187</a> <em>     * @deprecated Will be removed in a future version of Torque.</em>
<a name="188" href="#188">188</a> <em>     *             Use DatabaseInfo#getIdBroker() instead</em>
<a name="189" href="#189">189</a> <em>     *             to access the IDBroker.</em>
<a name="190" href="#190">190</a> <em>     */</em>
<a name="191" href="#191">191</a>     <strong>public</strong> <a href="../../../../org/apache/torque/oid/IDBroker.html">IDBroker</a> getIDBroker()
<a name="192" href="#192">192</a>     {
<a name="193" href="#193">193</a>         <strong>return</strong> idBroker;
<a name="194" href="#194">194</a>     }
<a name="195" href="#195">195</a> 
<a name="196" href="#196">196</a>     <em>/**<em>*</em></em>
<a name="197" href="#197">197</a> <em>     * Get the name of this database.</em>
<a name="198" href="#198">198</a> <em>     *</em>
<a name="199" href="#199">199</a> <em>     * @return A String.</em>
<a name="200" href="#200">200</a> <em>     * @deprecated Will be removed in a future version of Torque.</em>
<a name="201" href="#201">201</a> <em>     *             Use the name of the corresponding database instead.</em>
<a name="202" href="#202">202</a> <em>     */</em>
<a name="203" href="#203">203</a>     <strong>public</strong> String getName()
<a name="204" href="#204">204</a>     {
<a name="205" href="#205">205</a>         <strong>return</strong> name;
<a name="206" href="#206">206</a>     }
<a name="207" href="#207">207</a> 
<a name="208" href="#208">208</a>     <em>/**<em>*</em></em>
<a name="209" href="#209">209</a> <em>     * Get a TableMap for the table by name. &lt;p></em>
<a name="210" href="#210">210</a> <em>     *</em>
<a name="211" href="#211">211</a> <em>     * Note that by default Torque uses lazy initialization to minimize</em>
<a name="212" href="#212">212</a> <em>     * memory usage and startup time.  However, if an OM or PEER class</em>
<a name="213" href="#213">213</a> <em>     * has not called the table's MapBuilder class, it will not be here.</em>
<a name="214" href="#214">214</a> <em>     * See the optional initialize method if you need full OM Mapping.&lt;p></em>
<a name="215" href="#215">215</a> <em>     *</em>
<a name="216" href="#216">216</a> <em>     * @param name Name of the table.</em>
<a name="217" href="#217">217</a> <em>     * @return A TableMap, null if the table was not found.</em>
<a name="218" href="#218">218</a> <em>     */</em>
<a name="219" href="#219">219</a>     <strong>public</strong> <a href="../../../../org/apache/torque/map/TableMap.html">TableMap</a> getTable(String name)
<a name="220" href="#220">220</a>     {
<a name="221" href="#221">221</a>         <strong>return</strong> (TableMap) tables.get(name);
<a name="222" href="#222">222</a>     }
<a name="223" href="#223">223</a> 
<a name="224" href="#224">224</a>     <em>/**<em>*</em></em>
<a name="225" href="#225">225</a> <em>     * Get a TableMap[] of all of the tables in the database.&lt;P></em>
<a name="226" href="#226">226</a> <em>     *</em>
<a name="227" href="#227">227</a> <em>     * Note that by default Torque uses lazy initialization to minimize</em>
<a name="228" href="#228">228</a> <em>     * memory usage and startup time.  However, if an OM or PEER class</em>
<a name="229" href="#229">229</a> <em>     * has not called the table's MapBuilder class, it will not be here.</em>
<a name="230" href="#230">230</a> <em>     * See the optional initialize method if you need full OM Mapping.&lt;p></em>
<a name="231" href="#231">231</a> <em>     *</em>
<a name="232" href="#232">232</a> <em>     * @return A TableMap[].</em>
<a name="233" href="#233">233</a> <em>     */</em>
<a name="234" href="#234">234</a>     <strong>public</strong> <a href="../../../../org/apache/torque/map/TableMap.html">TableMap</a>[] getTables()
<a name="235" href="#235">235</a>     {
<a name="236" href="#236">236</a>         <a href="../../../../org/apache/torque/map/TableMap.html">TableMap</a>[] dbTables = <strong>new</strong> <a href="../../../../org/apache/torque/map/TableMap.html">TableMap</a>[tables.size()];
<a name="237" href="#237">237</a>         <strong>synchronized</strong> (tables)
<a name="238" href="#238">238</a>         {
<a name="239" href="#239">239</a>             Iterator it = tables.values().iterator();
<a name="240" href="#240">240</a>             <strong>int</strong> i = 0;
<a name="241" href="#241">241</a>             <strong>while</strong> (it.hasNext())
<a name="242" href="#242">242</a>             {
<a name="243" href="#243">243</a>                 dbTables[i++] = (TableMap) it.next();
<a name="244" href="#244">244</a>             }
<a name="245" href="#245">245</a>         }
<a name="246" href="#246">246</a>         <strong>return</strong> dbTables;
<a name="247" href="#247">247</a>     }
<a name="248" href="#248">248</a> 
<a name="249" href="#249">249</a>     <em>/**<em>*</em></em>
<a name="250" href="#250">250</a> <em>     * Add a new table to the database by name.  It creates an empty</em>
<a name="251" href="#251">251</a> <em>     * TableMap that you need to populate.</em>
<a name="252" href="#252">252</a> <em>     *</em>
<a name="253" href="#253">253</a> <em>     * @param tableName The name of the table.</em>
<a name="254" href="#254">254</a> <em>     */</em>
<a name="255" href="#255">255</a>     <strong>public</strong> <strong>void</strong> addTable(String tableName)
<a name="256" href="#256">256</a>     {
<a name="257" href="#257">257</a>         <a href="../../../../org/apache/torque/map/TableMap.html">TableMap</a> tmap = <strong>new</strong> <a href="../../../../org/apache/torque/map/TableMap.html">TableMap</a>(tableName, <strong>this</strong>);
<a name="258" href="#258">258</a>         tables.put(tableName, tmap);
<a name="259" href="#259">259</a>     }
<a name="260" href="#260">260</a> 
<a name="261" href="#261">261</a>     <em>/**<em>*</em></em>
<a name="262" href="#262">262</a> <em>     * Add a new table to the database by name.  It creates an empty</em>
<a name="263" href="#263">263</a> <em>     * TableMap that you need to populate.</em>
<a name="264" href="#264">264</a> <em>     *</em>
<a name="265" href="#265">265</a> <em>     * @param tableName The name of the table.</em>
<a name="266" href="#266">266</a> <em>     * @param numberOfColumns The number of columns in the table.</em>
<a name="267" href="#267">267</a> <em>     */</em>
<a name="268" href="#268">268</a>     <strong>public</strong> <strong>void</strong> addTable(String tableName, <strong>int</strong> numberOfColumns)
<a name="269" href="#269">269</a>     {
<a name="270" href="#270">270</a>         <a href="../../../../org/apache/torque/map/TableMap.html">TableMap</a> tmap = <strong>new</strong> <a href="../../../../org/apache/torque/map/TableMap.html">TableMap</a>(tableName, numberOfColumns, <strong>this</strong>);
<a name="271" href="#271">271</a>         tables.put(tableName, tmap);
<a name="272" href="#272">272</a>     }
<a name="273" href="#273">273</a> 
<a name="274" href="#274">274</a>     <em>/**<em>*</em></em>
<a name="275" href="#275">275</a> <em>     * Add a new TableMap to the database.</em>
<a name="276" href="#276">276</a> <em>     *</em>
<a name="277" href="#277">277</a> <em>     * @param map The TableMap representation.</em>
<a name="278" href="#278">278</a> <em>     */</em>
<a name="279" href="#279">279</a>     <strong>public</strong> <strong>void</strong> addTable(<a href="../../../../org/apache/torque/map/TableMap.html">TableMap</a> map)
<a name="280" href="#280">280</a>     {
<a name="281" href="#281">281</a>         tables.put(map.getName(), map);
<a name="282" href="#282">282</a>     }
<a name="283" href="#283">283</a> 
<a name="284" href="#284">284</a>     <em>/**<em>*</em></em>
<a name="285" href="#285">285</a> <em>     * Set the ID table for this database.</em>
<a name="286" href="#286">286</a> <em>     *</em>
<a name="287" href="#287">287</a> <em>     * @param idTable The TableMap representation for the ID table.</em>
<a name="288" href="#288">288</a> <em>     */</em>
<a name="289" href="#289">289</a>     <strong>public</strong> <strong>void</strong> setIdTable(<a href="../../../../org/apache/torque/map/TableMap.html">TableMap</a> idTable)
<a name="290" href="#290">290</a>     {
<a name="291" href="#291">291</a>         <strong>this</strong>.idTable = idTable;
<a name="292" href="#292">292</a>         addTable(idTable);
<a name="293" href="#293">293</a>     }
<a name="294" href="#294">294</a> 
<a name="295" href="#295">295</a>     <em>/**<em>*</em></em>
<a name="296" href="#296">296</a> <em>     * Set the ID table for this database.</em>
<a name="297" href="#297">297</a> <em>     *</em>
<a name="298" href="#298">298</a> <em>     * @param tableName The name for the ID table.</em>
<a name="299" href="#299">299</a> <em>     */</em>
<a name="300" href="#300">300</a>     <strong>public</strong> <strong>void</strong> setIdTable(String tableName)
<a name="301" href="#301">301</a>     {
<a name="302" href="#302">302</a>         <a href="../../../../org/apache/torque/map/TableMap.html">TableMap</a> tmap = <strong>new</strong> <a href="../../../../org/apache/torque/map/TableMap.html">TableMap</a>(tableName, <strong>this</strong>);
<a name="303" href="#303">303</a>         setIdTable(tmap);
<a name="304" href="#304">304</a>     }
<a name="305" href="#305">305</a> 
<a name="306" href="#306">306</a>     <em>/**<em>*</em></em>
<a name="307" href="#307">307</a> <em>     * Add a type of id generator for access by a TableMap.</em>
<a name="308" href="#308">308</a> <em>     *</em>
<a name="309" href="#309">309</a> <em>     * @param type a &lt;code>String&lt;/code> value</em>
<a name="310" href="#310">310</a> <em>     * @param idGen an &lt;code>IdGenerator&lt;/code> value</em>
<a name="311" href="#311">311</a> <em>     * @deprecated use DatabaseInfo.addGenerator() instead.</em>
<a name="312" href="#312">312</a> <em>     *             Will be removed in a future version of Torque.</em>
<a name="313" href="#313">313</a> <em>     */</em>
<a name="314" href="#314">314</a>     <strong>public</strong> <strong>void</strong> addIdGenerator(String type, <a href="../../../../org/apache/torque/oid/IdGenerator.html">IdGenerator</a> idGen)
<a name="315" href="#315">315</a>     {
<a name="316" href="#316">316</a>         idGenerators.put(type, idGen);
<a name="317" href="#317">317</a>     }
<a name="318" href="#318">318</a> 
<a name="319" href="#319">319</a>     <em>/**<em>*</em></em>
<a name="320" href="#320">320</a> <em>     * Get a type of id generator.  Valid values are listed in the</em>
<a name="321" href="#321">321</a> <em>     * {@link org.apache.torque.adapter.IDMethod} interface.</em>
<a name="322" href="#322">322</a> <em>     *</em>
<a name="323" href="#323">323</a> <em>     * @param type a &lt;code>String&lt;/code> value</em>
<a name="324" href="#324">324</a> <em>     * @return an &lt;code>IdGenerator&lt;/code> value</em>
<a name="325" href="#325">325</a> <em>     * @deprecated use DatabaseInfo.getIdGenerator() instead.</em>
<a name="326" href="#326">326</a> <em>     *             Will be removed in a future version of Torque.</em>
<a name="327" href="#327">327</a> <em>     */</em>
<a name="328" href="#328">328</a>     <strong>public</strong> <a href="../../../../org/apache/torque/oid/IdGenerator.html">IdGenerator</a> getIdGenerator(String type)
<a name="329" href="#329">329</a>     {
<a name="330" href="#330">330</a>         <strong>return</strong> (IdGenerator) idGenerators.get(type);
<a name="331" href="#331">331</a>     }
<a name="332" href="#332">332</a> 
<a name="333" href="#333">333</a>     <em>/**<em>*</em></em>
<a name="334" href="#334">334</a> <em>     * Creates the Idbroker for this DatabaseMap.</em>
<a name="335" href="#335">335</a> <em>     * If an IDBroker already exists for the DatabaseMap, the method</em>
<a name="336" href="#336">336</a> <em>     * does nothing.</em>
<a name="337" href="#337">337</a> <em>     * @return true if a new IdBroker was created, false otherwise.</em>
<a name="338" href="#338">338</a> <em>     * @deprecated Will be removed in a future version of Torque.</em>
<a name="339" href="#339">339</a> <em>     *             Use DatabaseInfo.startIdBroker() instead.</em>
<a name="340" href="#340">340</a> <em>     */</em>
<a name="341" href="#341">341</a>     <strong>public</strong> <strong>synchronized</strong> <strong>boolean</strong> startIdBroker()
<a name="342" href="#342">342</a>     {
<a name="343" href="#343">343</a>         <strong>if</strong> (idBroker == <strong>null</strong>)
<a name="344" href="#344">344</a>         {
<a name="345" href="#345">345</a>             setIdTable(<span class="string">"ID_TABLE"</span>);
<a name="346" href="#346">346</a>             <a href="../../../../org/apache/torque/map/TableMap.html">TableMap</a> tMap = getIdTable();
<a name="347" href="#347">347</a>             tMap.addPrimaryKey(<span class="string">"ID_TABLE_ID"</span>, <strong>new</strong> Integer(0));
<a name="348" href="#348">348</a>             tMap.addColumn(<span class="string">"TABLE_NAME"</span>, <span class="string">""</span>);
<a name="349" href="#349">349</a>             tMap.addColumn(<span class="string">"NEXT_ID"</span>, <strong>new</strong> Integer(0));
<a name="350" href="#350">350</a>             tMap.addColumn(<span class="string">"QUANTITY"</span>, <strong>new</strong> Integer(0));
<a name="351" href="#351">351</a>             idBroker = <strong>new</strong> <a href="../../../../org/apache/torque/oid/IDBroker.html">IDBroker</a>(idTable);
<a name="352" href="#352">352</a>             addIdGenerator(IDMethod.ID_BROKER, idBroker);
<a name="353" href="#353">353</a>             <strong>return</strong> <strong>true</strong>;
<a name="354" href="#354">354</a>         }
<a name="355" href="#355">355</a>         <strong>return</strong> false;
<a name="356" href="#356">356</a>     }
<a name="357" href="#357">357</a> 
<a name="358" href="#358">358</a>     <em>/**<em>*</em></em>
<a name="359" href="#359">359</a> <em>     * Fully populate this DatabaseMap with all the TablesMaps.  This</em>
<a name="360" href="#360">360</a> <em>     * is only needed if the application needs to use the complete OM</em>
<a name="361" href="#361">361</a> <em>     * mapping information.  Otherwise, the OM Mapping information</em>
<a name="362" href="#362">362</a> <em>     * will be populated as needed by OM and Peer classes.  An example</em>
<a name="363" href="#363">363</a> <em>     * of how to initialize the map info from the application:&lt;p></em>
<a name="364" href="#364">364</a> <em>     *</em>
<a name="365" href="#365">365</a> <em>     *   &lt;code></em>
<a name="366" href="#366">366</a> <em>     *   DatabaseMap dbMap = Torque.getDatabaseMap( dbName );</em>
<a name="367" href="#367">367</a> <em>     *   try {</em>
<a name="368" href="#368">368</a> <em>     *      dbMap.initialize();</em>
<a name="369" href="#369">369</a> <em>     *   } catch ( TorqueException e ) {</em>
<a name="370" href="#370">370</a> <em>     *      ... error handling</em>
<a name="371" href="#371">371</a> <em>     *   }</em>
<a name="372" href="#372">372</a> <em>     *   &lt;/code></em>
<a name="373" href="#373">373</a> <em>     *</em>
<a name="374" href="#374">374</a> <em>     * Note that Torque database names are case sensitive and this DB</em>
<a name="375" href="#375">375</a> <em>     * map must be retrieved with the exact name used in the XML schema.&lt;p></em>
<a name="376" href="#376">376</a> <em>     *</em>
<a name="377" href="#377">377</a> <em>     * This uses Java reflection methods to locate and run the</em>
<a name="378" href="#378">378</a> <em>     * init() method of a class generated in the org.apache.torque.linkage</em>
<a name="379" href="#379">379</a> <em>     * package with a name based on the XML Database name value, e.g.</em>
<a name="380" href="#380">380</a> <em>     * org.apache.torque.linkage.DefaultMapInit&lt;p></em>
<a name="381" href="#381">381</a> <em>     *</em>
<a name="382" href="#382">382</a> <em>     * Some misconfiguration situations that could cause this method to fail</em>
<a name="383" href="#383">383</a> <em>     * are:&lt;p></em>
<a name="384" href="#384">384</a> <em>     *</em>
<a name="385" href="#385">385</a> <em>     * It was used with a Torque OM set of classes generated by V3.2 or older;</em>
<a name="386" href="#386">386</a> <em>     * &lt;br></em>
<a name="387" href="#387">387</a> <em>     * The class(es) in the org.apache.torque.linkage package were not included</em>
<a name="388" href="#388">388</a> <em>     * with the other generated class files (e.g. the jar file creation process</em>
<a name="389" href="#389">389</a> <em>     * only included com.* and not org.* files).&lt;p></em>
<a name="390" href="#390">390</a> <em>     *</em>
<a name="391" href="#391">391</a> <em>     * @throws TorqueException If an error is encountered locating and calling</em>
<a name="392" href="#392">392</a> <em>     *                          the init method.</em>
<a name="393" href="#393">393</a> <em>     */</em>
<a name="394" href="#394">394</a>     <strong>public</strong> <strong>synchronized</strong> <strong>void</strong> initialize() throws TorqueException
<a name="395" href="#395">395</a>     {
<a name="396" href="#396">396</a>         <strong>if</strong> (isInitialized)
<a name="397" href="#397">397</a>         {
<a name="398" href="#398">398</a>             <strong>return</strong>;
<a name="399" href="#399">399</a>         }
<a name="400" href="#400">400</a>         String initClassName = MessageFormat.format(INIT_CLASS_NAME_FORMAT,
<a name="401" href="#401">401</a>                 <strong>new</strong> Object[] {
<a name="402" href="#402">402</a>                     javanameMethod(getName())
<a name="403" href="#403">403</a>                 });
<a name="404" href="#404">404</a> 
<a name="405" href="#405">405</a>         Class initClass = <strong>null</strong>;
<a name="406" href="#406">406</a>         <strong>try</strong>
<a name="407" href="#407">407</a>         {
<a name="408" href="#408">408</a>             initClass = Class.forName(initClassName);
<a name="409" href="#409">409</a>         }
<a name="410" href="#410">410</a>         <strong>catch</strong> (ClassNotFoundException e)
<a name="411" href="#411">411</a>         {
<a name="412" href="#412">412</a>             <strong>throw</strong> <strong>new</strong> <a href="../../../../org/apache/torque/TorqueException.html">TorqueException</a>(MessageFormat.format(
<a name="413" href="#413">413</a>                     ERROR_MESSAGES_INIT[0],
<a name="414" href="#414">414</a>                     <strong>new</strong> Object[] {
<a name="415" href="#415">415</a>                         getName(),
<a name="416" href="#416">416</a>                         initClassName
<a name="417" href="#417">417</a>                     }),
<a name="418" href="#418">418</a>                     e);
<a name="419" href="#419">419</a>         }
<a name="420" href="#420">420</a>         <strong>catch</strong> (LinkageError e)
<a name="421" href="#421">421</a>         {
<a name="422" href="#422">422</a>             <strong>throw</strong> <strong>new</strong> <a href="../../../../org/apache/torque/TorqueException.html">TorqueException</a>(MessageFormat.format(
<a name="423" href="#423">423</a>                     ERROR_MESSAGES_INIT[1],
<a name="424" href="#424">424</a>                     <strong>new</strong> Object[] {
<a name="425" href="#425">425</a>                         getName(), initClassName
<a name="426" href="#426">426</a>                     }),
<a name="427" href="#427">427</a>                     e);
<a name="428" href="#428">428</a>         }
<a name="429" href="#429">429</a>         <strong>catch</strong> (Throwable e)
<a name="430" href="#430">430</a>         {
<a name="431" href="#431">431</a>             <strong>throw</strong> <strong>new</strong> <a href="../../../../org/apache/torque/TorqueException.html">TorqueException</a>(MessageFormat.format(
<a name="432" href="#432">432</a>                     ERROR_MESSAGES_INIT[2],
<a name="433" href="#433">433</a>                     <strong>new</strong> Object[] {
<a name="434" href="#434">434</a>                         getName(), initClassName
<a name="435" href="#435">435</a>                     }),
<a name="436" href="#436">436</a>                     e);
<a name="437" href="#437">437</a>         }
<a name="438" href="#438">438</a>         <strong>try</strong>
<a name="439" href="#439">439</a>         {
<a name="440" href="#440">440</a>             Method initMethod = initClass.getMethod(<span class="string">"init"</span>, (Class []) <strong>null</strong>);
<a name="441" href="#441">441</a>             initMethod.invoke(<strong>null</strong>, (Object []) <strong>null</strong>);
<a name="442" href="#442">442</a>         }
<a name="443" href="#443">443</a>         <strong>catch</strong> (Exception e)
<a name="444" href="#444">444</a>         {
<a name="445" href="#445">445</a>             <strong>throw</strong> <strong>new</strong> <a href="../../../../org/apache/torque/TorqueException.html">TorqueException</a>(MessageFormat.format(
<a name="446" href="#446">446</a>                     ERROR_MESSAGES_INIT[3],
<a name="447" href="#447">447</a>                     <strong>new</strong> Object[] {
<a name="448" href="#448">448</a>                         getName(), initClassName
<a name="449" href="#449">449</a>                     }),
<a name="450" href="#450">450</a>                     e);
<a name="451" href="#451">451</a>         }
<a name="452" href="#452">452</a>         isInitialized = <strong>true</strong>;
<a name="453" href="#453">453</a>     }
<a name="454" href="#454">454</a> 
<a name="455" href="#455">455</a>     <em>/**<em>*</em></em>
<a name="456" href="#456">456</a> <em>     * Converts a database schema name to java object name.  Operates</em>
<a name="457" href="#457">457</a> <em>     * same as underscoreMethod but does not convert anything to</em>
<a name="458" href="#458">458</a> <em>     * lowercase.  This must match the javaNameMethod in the</em>
<a name="459" href="#459">459</a> <em>     * JavaNameGenerator class in Generator code.</em>
<a name="460" href="#460">460</a> <em>     *</em>
<a name="461" href="#461">461</a> <em>     * @param schemaName name to be converted.</em>
<a name="462" href="#462">462</a> <em>     * @return converted name.</em>
<a name="463" href="#463">463</a> <em>     *</em>
<a name="464" href="#464">464</a> <em>     * @see org.apache.torque.engine.database.model.NameGenerator</em>
<a name="465" href="#465">465</a> <em>     */</em>
<a name="466" href="#466">466</a>     <strong>protected</strong> String javanameMethod(String schemaName)
<a name="467" href="#467">467</a>     {
<a name="468" href="#468">468</a>         StringBuffer result = <strong>new</strong> StringBuffer();
<a name="469" href="#469">469</a>         StringTokenizer tok = <strong>new</strong> StringTokenizer
<a name="470" href="#470">470</a>             (schemaName, String.valueOf(STD_SEPARATOR_CHAR));
<a name="471" href="#471">471</a>         <strong>while</strong> (tok.hasMoreTokens())
<a name="472" href="#472">472</a>         {
<a name="473" href="#473">473</a>             String namePart = (String) tok.nextElement();
<a name="474" href="#474">474</a>             result.append(StringUtils.capitalize(namePart));
<a name="475" href="#475">475</a>         }
<a name="476" href="#476">476</a> 
<a name="477" href="#477">477</a>         <em class="comment">// remove the SCHEMA_SEPARATOR_CHARs and capitalize</em>
<a name="478" href="#478">478</a>         <em class="comment">// the tokens</em>
<a name="479" href="#479">479</a>         schemaName = result.toString();
<a name="480" href="#480">480</a>         result = <strong>new</strong> StringBuffer();
<a name="481" href="#481">481</a> 
<a name="482" href="#482">482</a>         tok = <strong>new</strong> StringTokenizer
<a name="483" href="#483">483</a>             (schemaName, String.valueOf(SCHEMA_SEPARATOR_CHAR));
<a name="484" href="#484">484</a>         <strong>while</strong> (tok.hasMoreTokens())
<a name="485" href="#485">485</a>         {
<a name="486" href="#486">486</a>             String namePart = (String) tok.nextElement();
<a name="487" href="#487">487</a>             result.append(StringUtils.capitalize(namePart));
<a name="488" href="#488">488</a>         }
<a name="489" href="#489">489</a>         <strong>return</strong> result.toString();
<a name="490" href="#490">490</a>     }
<a name="491" href="#491">491</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

